Vcenter Compute Policies Capabilities Vm Evacuation BestEffortRestart CreateSpec

The Vcenter Compute Policies Capabilities Vm Evacuation BestEffortRestart CreateSpec schema contains information used to create a new policy that applies to virtual machines when their host is entering maintenance mode and that will cause these virtual machines to enter a powered-off state; after which these virtual machines will be powered-on as soon as possible, see POST /vcenter/compute/policies. All virtual machines that are running on a host that is entering maintenance-mode and that have the tag indicated by Vcenter Compute Policies Capabilities Vm Evacuation BestEffortRestart CreateSpec.vm_tag will go through a guest shut-down. If guest shut-down is unavailable or doesn't complete in time, then the VM is powered-off. Virtual machines that are in a powered-off state because of this policy will be attempted to be powered-on every few minutes. The host on which the VM will be powered-on can be different than the host where the VM was initially running.

This schema was added in vSphere API 8.0.3.0.

AllOf

This class requires all of the following:

Vcenter Compute Policies CreateSpec

JSON Example

{
    "capability": "string",
    "name": "string",
    "description": "string",
    "vm_tag": "string"
}

string

vm_tag

Required

Identifier of a tag that can be associated with a virtual machine. All virtual machines that have the tag indicated by Vcenter Compute Policies Capabilities Vm Evacuation BestEffortRestart CreateSpec.vm_tag will go through a guest shut-down if their host is entering maintenance-mode. If guest shut-down is unavailable or doesn’t complete in time, then the VM is powered-off. Virtual machines that are in a powered-off state because of this policy will be attempted to be powered-on every few minutes. The host on which the VM will be powered-on can be different than the host where the VM was initially running.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.